Skip to content

Remove duplicate Query by Example collection-property note#4270

Closed
jewoodev wants to merge 1 commit into
spring-projects:mainfrom
jewoodev:gh-1472-qbe-collection-doc
Closed

Remove duplicate Query by Example collection-property note#4270
jewoodev wants to merge 1 commit into
spring-projects:mainfrom
jewoodev:gh-1472-qbe-collection-doc

Conversation

@jewoodev

@jewoodev jewoodev commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Spring Data JPA already renders the shared Query by Example limitations section with :support-qbe-collection: false, which includes "No support for matching collections or maps."

This removes the JPA-specific SingularAttribute NOTE because it describes the same limitation in a duplicate location and with less user-facing terminology. Runtime behavior matches the shared wording: QueryByExamplePredicateBuilder iterates over type.getSingularAttributes(), so plural attributes are not matched.

No production code changes.

Closes #1472

The JPA module sets `:support-qbe-collection: false` at the top of
`query-by-example.adoc`, which enables the
"No support for matching collections or maps." bullet in the
limitations list rendered from the Spring Data Commons page.

The standalone JPA-specific NOTE placed right after the repository
usage example duplicates that limitation in less accessible wording
(the JPA metamodel term `SingularAttribute`) and at an unrelated
location. Drop it so the limitation is communicated once, in the
limitations section, with end-user terminology.

Closes spring-projects#1472

Signed-off-by: jewoodev <jewoos15@naver.com>
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 4, 2026
@mp911de mp911de added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Jun 5, 2026
@mp911de mp911de added this to the 3.5.12 (2025.0.12) milestone Jun 5, 2026
mp911de pushed a commit that referenced this pull request Jun 5, 2026
Closes #1472
Original pull request: #4270

Signed-off-by: jewoodev <jewoos15@naver.com>
mp911de pushed a commit that referenced this pull request Jun 5, 2026
Closes #1472
Original pull request: #4270

Signed-off-by: jewoodev <jewoos15@naver.com>
mp911de pushed a commit that referenced this pull request Jun 5, 2026
Closes #1472
Original pull request: #4270

Signed-off-by: jewoodev <jewoos15@naver.com>
@mp911de

mp911de commented Jun 5, 2026

Copy link
Copy Markdown
Member

Thank you for your contribution. That's merged and backported now.

@mp911de mp911de closed this Jun 5, 2026
@jewoodev jewoodev deleted the gh-1472-qbe-collection-doc branch June 5, 2026 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation A documentation update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation to clearly state that Query By Example ignores collections [DATAJPA-1127]

3 participants